home *** CD-ROM | disk | FTP | other *** search
/ PC World Komputer 2010 April / PCWorld0410.iso / pluginy Firefox / 10868 / 10868.xpi / modules / engines / forms.js < prev    next >
Text File  |  2010-02-02  |  9KB  |  300 lines
  1. /* ***** BEGIN LICENSE BLOCK *****
  2.  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
  3.  *
  4.  * The contents of this file are subject to the Mozilla Public License Version
  5.  * 1.1 (the "License"); you may not use this file except in compliance with
  6.  * the License. You may obtain a copy of the License at
  7.  * http://www.mozilla.org/MPL/
  8.  *
  9.  * Software distributed under the License is distributed on an "AS IS" basis,
  10.  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  11.  * for the specific language governing rights and limitations under the
  12.  * License.
  13.  *
  14.  * The Original Code is Bookmarks Sync.
  15.  *
  16.  * The Initial Developer of the Original Code is Mozilla.
  17.  * Portions created by the Initial Developer are Copyright (C) 2008
  18.  * the Initial Developer. All Rights Reserved.
  19.  *
  20.  * Contributor(s):
  21.  *  Anant Narayanan <anant@kix.in>
  22.  *
  23.  * Alternatively, the contents of this file may be used under the terms of
  24.  * either the GNU General Public License Version 2 or later (the "GPL"), or
  25.  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  26.  * in which case the provisions of the GPL or the LGPL are applicable instead
  27.  * of those above. If you wish to allow use of your version of this file only
  28.  * under the terms of either the GPL or the LGPL, and not to allow others to
  29.  * use your version of this file under the terms of the MPL, indicate your
  30.  * decision by deleting the provisions above and replace them with the notice
  31.  * and other provisions required by the GPL or the LGPL. If you do not delete
  32.  * the provisions above, a recipient may use your version of this file under
  33.  * the terms of any one of the MPL, the GPL or the LGPL.
  34.  *
  35.  * ***** END LICENSE BLOCK ***** */
  36.  
  37. const EXPORTED_SYMBOLS = ['FormEngine'];
  38.  
  39. const Cc = Components.classes;
  40. const Ci = Components.interfaces;
  41. const Cu = Components.utils;
  42.  
  43. Cu.import("resource://gre/modules/XPCOMUtils.jsm");
  44. Cu.import("resource://weave/util.js");
  45. Cu.import("resource://weave/engines.js");
  46. Cu.import("resource://weave/stores.js");
  47. Cu.import("resource://weave/trackers.js");
  48. Cu.import("resource://weave/type_records/forms.js");
  49.  
  50. function FormEngine() {
  51.   this._init();
  52. }
  53. FormEngine.prototype = {
  54.   __proto__: SyncEngine.prototype,
  55.   name: "forms",
  56.   _displayName: "Forms",
  57.   description: "Take advantage of form-fill convenience on all your devices",
  58.   logName: "Forms",
  59.   _storeObj: FormStore,
  60.   _trackerObj: FormTracker,
  61.   _recordObj: FormRec,
  62.   get prefName() "history",
  63.  
  64.   _syncStartup: function FormEngine__syncStartup() {
  65.     this._store.cacheFormItems();
  66.     SyncEngine.prototype._syncStartup.call(this);
  67.   },
  68.  
  69.   /* Wipe cache when sync finishes */
  70.   _syncFinish: function FormEngine__syncFinish(error) {
  71.     this._store.clearFormCache();
  72.     SyncEngine.prototype._syncFinish.call(this);
  73.   },
  74.  
  75.   _findDupe: function _findDupe(item) {
  76.     // Search through the items to find a matching name/value
  77.     for (let [guid, {name, value}] in Iterator(this._store._formItems))
  78.       if (name == item.name && value == item.value)
  79.         return guid;
  80.   }
  81. };
  82.  
  83.  
  84. function FormStore() {
  85.   this._init();
  86. }
  87. FormStore.prototype = {
  88.   __proto__: Store.prototype,
  89.   name: "forms",
  90.   _logName: "FormStore",
  91.   _formItems: null,
  92.  
  93.   get _formDB() {
  94.     let file = Cc["@mozilla.org/file/directory_service;1"].
  95.       getService(Ci.nsIProperties).
  96.       get("ProfD", Ci.nsIFile);
  97.     file.append("formhistory.sqlite");
  98.     let stor = Cc["@mozilla.org/storage/service;1"].
  99.       getService(Ci.mozIStorageService);
  100.     let formDB = stor.openDatabase(file);
  101.  
  102.     this.__defineGetter__("_formDB", function() formDB);
  103.     return formDB;
  104.   },
  105.  
  106.   get _formHistory() {
  107.     let formHistory = Cc["@mozilla.org/satchel/form-history;1"].
  108.       getService(Ci.nsIFormHistory2);
  109.     this.__defineGetter__("_formHistory", function() formHistory);
  110.     return formHistory;
  111.   },
  112.  
  113.   get _formStatement() {
  114.     // This is essentially:
  115.     // SELECT * FROM moz_formhistory ORDER BY 1.0 * (lastUsed - minLast) /
  116.     // (maxLast - minLast) * timesUsed / minTimes DESC LIMIT 200
  117.     let stmnt = this._formDB.createStatement(
  118.         "SELECT * FROM moz_formhistory ORDER BY 1.0 * (lastUsed - \
  119.         (SELECT lastUsed FROM moz_formhistory ORDER BY lastUsed ASC LIMIT 1)) / \
  120.         ((SELECT lastUsed FROM moz_formhistory ORDER BY lastUsed DESC LIMIT 1) - \
  121.         (SELECT lastUsed FROM moz_formhistory ORDER BY lastUsed ASC LIMIT 1)) * \
  122.         timesUsed / (SELECT timesUsed FROM moz_formhistory ORDER BY timesUsed DESC LIMIT 1) \
  123.         DESC LIMIT 200"
  124.     );
  125.  
  126.     this.__defineGetter__("_formStatement", function() stmnt);
  127.     return stmnt;
  128.   },
  129.  
  130.   cacheFormItems: function FormStore_cacheFormItems() {
  131.     this._log.trace("Caching all form items");
  132.     this._formItems = this.getAllIDs();
  133.   },
  134.  
  135.   clearFormCache: function FormStore_clearFormCache() {
  136.     this._log.trace("Clearing form cache");
  137.     this._formItems = null;
  138.   },
  139.  
  140.   getAllIDs: function FormStore_getAllIDs() {
  141.     let items = {};
  142.     let stmnt = this._formStatement;
  143.  
  144.     while (stmnt.executeStep()) {
  145.       let nam = stmnt.getUTF8String(1);
  146.       let val = stmnt.getUTF8String(2);
  147.       let key = Utils.sha1(nam + val);
  148.  
  149.       items[key] = { name: nam, value: val };
  150.     }
  151.     stmnt.reset();
  152.  
  153.     return items;
  154.   },
  155.  
  156.   changeItemID: function FormStore_changeItemID(oldID, newID) {
  157.     this._log.warn("FormStore IDs are data-dependent, cannot change!");
  158.   },
  159.  
  160.   itemExists: function FormStore_itemExists(id) {
  161.     return (id in this._formItems);
  162.   },
  163.  
  164.   createRecord: function FormStore_createRecord(guid, cryptoMetaURL) {
  165.     let record = new FormRec();
  166.     record.id = guid;
  167.  
  168.     if (guid in this._formItems) {
  169.       let item = this._formItems[guid];
  170.       record.encryption = cryptoMetaURL;
  171.       record.name = item.name;
  172.       record.value = item.value;
  173.     } else {
  174.       record.deleted = true;
  175.     }
  176.  
  177.     return record;
  178.   },
  179.  
  180.   create: function FormStore_create(record) {
  181.     this._log.debug("Adding form record for " + record.name);
  182.     this._formHistory.addEntry(record.name, record.value);
  183.   },
  184.  
  185.   remove: function FormStore_remove(record) {
  186.     this._log.trace("Removing form record: " + record.id);
  187.  
  188.     if (record.id in this._formItems) {
  189.       let item = this._formItems[record.id];
  190.       this._formHistory.removeEntry(item.name, item.value);
  191.       return;
  192.     }
  193.  
  194.     this._log.trace("Invalid GUID found, ignoring remove request.");
  195.   },
  196.  
  197.   update: function FormStore_update(record) {
  198.     this._log.warn("Ignoring form record update request!");
  199.   },
  200.  
  201.   wipe: function FormStore_wipe() {
  202.     this._formHistory.removeAllEntries();
  203.   }
  204. };
  205.  
  206. function FormTracker() {
  207.   this._init();
  208. }
  209. FormTracker.prototype = {
  210.   __proto__: Tracker.prototype,
  211.   name: "forms",
  212.   _logName: "FormTracker",
  213.   file: "form",
  214.  
  215.   QueryInterface: XPCOMUtils.generateQI([Ci.nsIFormSubmitObserver]),
  216.  
  217.   __observerService: null,
  218.   get _observerService() {
  219.     if (!this.__observerService)
  220.       this.__observerService = Cc["@mozilla.org/observer-service;1"].
  221.                                 getService(Ci.nsIObserverService);
  222.       return this.__observerService;
  223.   },
  224.  
  225.   _init: function FormTracker__init() {
  226.     this.__proto__.__proto__._init.call(this);
  227.     this._log.trace("FormTracker initializing!");
  228.     this._observerService.addObserver(this, "earlyformsubmit", false);
  229.   },
  230.  
  231.   /* 10 points per form element */
  232.   notify: function FormTracker_notify(formElement, aWindow, actionURI) {
  233.     if (this.ignoreAll)
  234.       return;
  235.  
  236.     this._log.trace("Form submission notification for " + actionURI.spec);
  237.  
  238.     // XXX Bug 487541 Copy the logic from nsFormHistory::Notify to avoid
  239.     // divergent logic, which can lead to security issues, until there's a
  240.     // better way to get satchel's results like with a notification.
  241.  
  242.     // Determine if a dom node has the autocomplete attribute set to "off"
  243.     let completeOff = function(domNode) {
  244.       let autocomplete = domNode.getAttribute("autocomplete");
  245.       return autocomplete && autocomplete.search(/^off$/i) == 0;
  246.     }
  247.  
  248.     if (completeOff(formElement)) {
  249.       this._log.trace("Form autocomplete set to off");
  250.       return;
  251.     }
  252.  
  253.     /* Get number of elements in form, add points and changedIDs */
  254.     let len = formElement.length;
  255.     let elements = formElement.elements;
  256.     for (let i = 0; i < len; i++) {
  257.       let el = elements.item(i);
  258.  
  259.       // Grab the name for debugging, but check if empty when satchel would
  260.       let name = el.name;
  261.       if (name === "")
  262.         name = el.id;
  263.  
  264.       if (!(el instanceof Ci.nsIDOMHTMLInputElement)) {
  265.         this._log.trace(name + " is not a DOMHTMLInputElement: " + el);
  266.         continue;
  267.       }
  268.  
  269.       if (el.type.search(/^text$/i) != 0) {
  270.         this._log.trace(name + "'s type is not 'text': " + el.type);
  271.         continue;
  272.       }
  273.  
  274.       if (completeOff(el)) {
  275.         this._log.trace(name + "'s autocomplete set to off");
  276.         continue;
  277.       }
  278.  
  279.       if (el.value === "") {
  280.         this._log.trace(name + "'s value is empty");
  281.         continue;
  282.       }
  283.  
  284.       if (el.value == el.defaultValue) {
  285.         this._log.trace(name + "'s value is the default");
  286.         continue;
  287.       }
  288.  
  289.       if (name === "") {
  290.         this._log.trace("Text input element has no name or id");
  291.         continue;
  292.       }
  293.  
  294.       this._log.trace("Logging form element: " + name + " :: " + el.value);
  295.       this.addChangedID(Utils.sha1(name + el.value));
  296.       this.score += 10;
  297.     }
  298.   }
  299. };
  300.